home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / misc / xref_v1.1.lha / XRef / Doc / english / makexref.doc < prev    next >
Encoding:
Text File  |  1995-01-09  |  3.8 KB  |  120 lines
  1. XRef-Tools/MakeXRef                                         XRef-Tools/MakeXRef
  2.  
  3. $VER: makexref.doc 1.20 (19.11.94)
  4.  
  5. NAME
  6.     MakeXRef - generate a xreffile for amigaguide from c-header, amigaguide,
  7.                autodoc, unix man pages and normal doc files
  8.  
  9. TEMPLATE
  10.     FROM/A/M,TO/A,CATEGORY/K,PATH/K,VERSION/N/K,REVISION/N/K,VERBOSE
  11.  
  12. FORMAT
  13.     MakeXRef [FROM] file|dir [file2|dir2] [TO] file [CATEGORY category] 
  14.              [PATH gpath] [VERSION versionnr] [REVISION revisionnr] [VERBOSE]
  15.  
  16. FUNCTION
  17.     generate xref-file for use with xref.library.This tool scans any autodoc,
  18.     amigaguide ,C-Header, unix man page and normal doc file. The following 
  19.     entry types are recognized :
  20.         in C-Header files :
  21.         - normal define's
  22.         - macro define's
  23.         - structures
  24.         - typedef's
  25.         in autodoc,amigaguide, unix man page and normal doc files :
  26.         - function's
  27.         - command's (device command's for example)
  28.         - generic (all other entries, which doesn't fit in the types above)
  29.  
  30.     If started from workbench, it opens a status window, which displays the
  31.     current state of the program. Also it calculates the time to be used until
  32.     the program finishes. Take just a look at !
  33.  
  34. INPUTS
  35.     FROM    - File(s) or director(y|ies) to scan
  36.  
  37.     TO      - File to hold all xref-entries
  38.  
  39.     CATEGORY- category to use implicit for this xreffile (this is saved in
  40.               the xreffile). Note this is the specification of the category,
  41.               so you can't use any pattern !
  42.  
  43.     PATH    - global path, which is prepend to each filename for a entry, so
  44.               you can build absolute filepath for a entry, this path is stored
  45.               only once in a xreffile.
  46.  
  47.     VERSION - version of the created xreffile
  48.  
  49.     REVISION- revision of the created xreffile
  50.  
  51.     NOICON  - don't create a icon for the generated xreffile
  52.  
  53.     VERBOSE - switch, that indicate you want to see the found entries
  54.  
  55. SEE ALSO
  56.     ParseXRef, AGuideXRefV37, AGuideXRefV39, LoadXRef, ExpungeXRef,
  57.     libraries/amigaguide.h, libraries/xref.h
  58.  
  59. COPYRIGHT
  60.     (C) by Stefan Ruppert 1994
  61.  
  62. HISTORY
  63.     MakeXRef 1.20 (19.11.94) :
  64.         - new AUTHOR,NAME options
  65.         - generates now AmigaDOS 2.0 version string
  66.  
  67.     MakeXRef 1.19 (3.11.94) :
  68.         - intern Icon definition corrected
  69.  
  70.     MakeXRef 1.18 (25.9.94) :
  71.         - in header files line number was not correct in some cases
  72.  
  73.     MakeXRef 1.17 (24.9.94) :
  74.         - if only a file was passed , it wasn't opened . This is fixed !
  75.  
  76.     MakeXRef 1.16 (10.9.94) :
  77.         - status window added , if started from Workbench
  78.  
  79.     MakeXRef 1.15 (7.9.94) :
  80.         - workbench support added
  81.         - now patterns can be used for the FROM argument
  82.  
  83.     MakeXRef 1.14 (3.9.94) :
  84.         - some changes to reflect new tags
  85.         - scan_man() function now strips backspaces
  86.  
  87.     MakeXRef 1.13 (29.8.94) :
  88.         - added support of unix manual pages
  89.  
  90.     MakeXRef 1.12 (28.7.94) :
  91.         - in amigaguide scan , there was a bug, which interpreted a space in a
  92.           a node name as a normal character. This is fixed !
  93.         - path now check for last character (':','/')
  94.  
  95.     MakeXRef 1.11 (20.7.94) :
  96.         - PATH option added.
  97.  
  98.     MakeXRef 1.10 (9.7.94) :
  99.         - added support for typedefs, macros, commands and generic
  100.         - now handles datatypes,gadgets and handlers as generic
  101.         - some bug fixes
  102.  
  103.     MakeXRef 1.9 (19.6.94) :
  104.         - now uses the xref.library function to create a xreffile
  105.           the library handles now all entry and file names.It sorts
  106.           all names and create an index for each entry.
  107.  
  108.     MakeXRef 1.8 (5.6.94) :
  109.         - now strips ".doc" from an autodoc file in the xref file
  110.  
  111.     MakeXRef 1.7 (22.5.94) :
  112.         - now supports C-header files
  113.  
  114.     MakeXRef 1.6 (10.5.94) :
  115.         - xref file format changed
  116.  
  117.     MakeXRef 1.5 (7.5.94) :
  118.         - first beta release
  119.  
  120.